hilitePattern

Type

property

Summary

Specifies the fill pattern used for the background when an object, or text in an object, is highlighted.

Syntax

set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty}

Description

Use the hilitePattern property to specify the background pattern used for the selected text in a field, or the highlighted pattern of a clicked object, or the pattern of graphic markers.

Pattern images can be color or black-and-white.

Cross-platform note

To be used as a pattern on Mac OS systems, an image must be 128x128 pixels or less, and both its height and width must be a power of 2. To be used on Windows and Unix systems, height and width must be divisible by 8. To be used as a fully cross-platform pattern, both an image's dimensions should be one of 8, 16, 32, 64, or 128.

The hilitePattern of controls is drawn starting at the control's upper right corner: if the control is moved, the pattern does not shift.

The setting of the hilitePattern property has different effects, depending on the object type:

• The hilitePattern of a stack, card, or group determines the hilitePattern of any object in the stack, card, or group that does not have its own hilitePattern.

• The hilitePattern of a button is used for the background of the button when it is highlighted. If the button is a menu, the hilitePattern is used to highlight the button, but not the active menu choice. The hilitePattern has no effect if the button is a tabbed button. The hilitePattern has no effect until the button is highlighted.

Cross-platform note

If the lookAndFeel is set to "Appearance Manager", standard and rectangle buttons are drawn by the operating system if the backgroundColor and backgroundPattern of the button and all of its owners is empty. In this case, the button's hilitePattern has no effect. Otherwise, the button is drawn by LiveCode. If the lookAndFeel is "Appearance Manager", button menus whose menuMode is set to "option" are always drawn by the operating system, and the setting of the button's hilitePattern does not affect them.

• The hilitePattern of a field determines the background color of text selections in the field.

• The hilitePattern of a scrollbar fills the arrow boxes at the ends of the scrollbar when the arrows are clicked. The hilitePattern has no effect until the arrows are clicked.

• The hilitePattern of a graphic, image, player, or EPS|EPS object has no effect.

If the object's hilitePattern is set, the pattern is shown instead of the color specified by hiliteColor.

note

Unlike the hiliteColor property, the hilitePattern is not a global property. Setting the hilitePattern of an object to empty causes the hilitePattern of the object's owner to be used for the object.

Examples

set the hilitePattern to 3859

Related

command: global, group

function: stacks

glossary: object, owner, current stack, tabbed button, property, highlight, button menu, Windows, select, Mac OS, Unix, object type, selection, EPS

keyword: field, image, button, menu, card, graphic, scrollbar, control, player

object: button, stack

property: bottomPattern, hiliteFill, pixels, hiliteColor, markerLineSize, height, backgroundPattern, lookAndFeel, menuMode, backgroundColor

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile